home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 005a / ufrd100.zip / SYSOP.DOC < prev   
Text File  |  1993-03-14  |  17KB  |  396 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                 ---- The Ultimate File Request Door ----
  9.  
  10.                              Version 1.00
  11.  
  12.                         Written By: Paul Taylor
  13.  
  14.                             15 March 1993
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.          Copyright (c) 1993, Paul Taylor.  All Rights Reserved
  23.  
  24. Ultimate File Request v1.00                             Sysop Documentation
  25.  
  26.  
  27. Foreword
  28.  
  29.    I apologize in advance for this document.  This is my first attempt at
  30. writing documentation for any product, so give me a little slack, please.
  31. Thanks.. I knew all of you would understand.  If there are any points in
  32. this that you need clarification on, please contact me.  I can be reached
  33. at ShadowRift BBS (Number & other info at end of document). Thanks again!
  34.  
  35.  
  36. Registration
  37.  
  38.    The software in this package is a fully functional version of the
  39. Ultimate File Request Door.  It is completely functional, but it does not
  40. include the data file editors (which are needed for maintaining your
  41. Request List) nor the Data File to Text File conversion utility.  Everyone
  42. is granted a limited 30 day license to use this program, but after that
  43. you must register.  Please remember, this is not freeware and is copyrighted.
  44.  
  45.    Registration is only $20 and it gets you the most up to date version,
  46. support and assistance (beyond basic installation help that is available
  47. for everyone).  You also receive the Request Editor, which allows you to
  48. unfulfill requests (in the case of accidental fulfillment) and edit and
  49. delete tag messages as well as the requests themselves.  Along with this
  50. you will get the RDAT2TXT utility which converts the current version of
  51. your Request Data file into a text file, suitable for posting as a bulletin
  52. or download.
  53.  
  54.    If this all sounds like a good deal, please fill out the registration
  55. form and make your check or money order payable to:
  56.  
  57.                     Paul Taylor
  58.                     P.O. Box 26190
  59.                     Jacksonville, Fl. 32226-6190
  60.  
  61.    If all goes well, within 3 weeks you should receive a disk in the mail.
  62. You can, however, download your registered version from ShadowRift BBS.  We
  63. recommend that you call and let us know your registration is on its way so
  64. that way we can post your registered version as soon as we receive the
  65. registration.  If you have a valid FIDO net address, please let us know and
  66. we can send it to you directly if you have no objections.
  67.  
  68. Disclaimer
  69.  
  70.    The Ultimate File Request Door is distributed as is.  There are no
  71. warranties, expressed or implied.  By setting up and running the Ultimate
  72. File Request Door, you are releasing Paul Taylor and ShadowRift BBS
  73. from any liability for any damage that may occur by the use or misuse of
  74. our programs.
  75.  
  76. Features
  77.  
  78.   The Ultimate File Request Door is a utility to help the users of your
  79. BBS find the files they need the most.  It allows your users to enter up
  80. to an 8 line description of the type of file they are looking for.  Other
  81. users can then look at this list of requested files and, if they have one
  82. and are willing to upload, they can fulfill one of those requests.  If
  83. set up properly, the user who requested the file will get a message next
  84. time he logs on, telling him that his request was uploaded and it's
  85. filename.  If a user requests a file that is already on the system, and
  86. another user notices it, he can let the person know by adding a
  87. "Tag Message" to the request.
  88.  
  89.    Entering the Request Door
  90.  
  91.      Upon entering the door, the user will be displayed a message indicating
  92.  the name of the door and the current version number, followed by a sysop
  93.  defined ANSI file (INTRO.ANS).  This ANSI file is typically used to let users know
  94.  the rewards of fulfilling requests.  Sometimes, users even offer some of
  95.  their upload credit for a specific file.
  96.  
  97.  
  98.    Main Menu
  99.  
  100.      From the main menu, the users can add a request, view all current
  101.  requests, add a Tag Message, or indicate that he has fulfilled a request.
  102.  (Some Sysops encourage their users to fulfill requests by offering extra
  103.  upload credit as incentive.)
  104.  
  105.    Adding a Request
  106.  
  107.    First asks the user for a filename, then for a description, up to 8 lines.
  108.  Then, it stamps the request with a date and regurgitates the colorized
  109.  version to the user to make sure it's what he/she wants.
  110.  
  111.    Viewing Requests
  112.  
  113.    This option asks the user if they want a Limited listing or an
  114.  extended listing.  The Extended listing shows all lines of the description
  115.  plus all Tag messages attached to them.  (The tag messages are intended
  116.  for other users to HELP the user who originally requested the file, not
  117.  to express their personal thoughts).  The Limited listing shows only
  118.  the first two lines of each file, without tagged messages.  NOTE: In local
  119.  mode, the CYAN blocks (■) next to the filename indicate that it has not
  120.  yet been fulfilled.  If a file has been fulfilled, it is no longer shown
  121.  to users, but in local mode (and in REDIT) files who have been fulfilled
  122.  have Red blocks next to them, instead of cyan ones.
  123.  
  124.    Indicate you have Fulfilled a Request
  125.  
  126.    This option firsts asks which filename has been fulfilled.  If the user
  127.  enters a valid filename, they will be asked if they uploaded under the
  128.  exact filename that it was requested under.  If not, it asks them for the
  129.  exact filename, and then saves off a message to the requester of that file.
  130.  RMAIL, upon the login of the user who requested the file, will let that
  131.  user know his request has been answered.  Once a request has been fulfilled
  132.  it is no longer displayed to users.  REDIT has the option to unfulfill
  133.  as request in the event a mistake has been made.
  134.  
  135.  
  136. Installation
  137.  
  138.    Unzip the REQUEST archive into the sub-directory that you plan to run
  139. the REQUEST from.  Depending on which type of BBS software you are running,
  140. you should choose the appropriate command line parameters from the
  141. listing below:
  142.  
  143.          Parameter      Drop file      BBS Software - Notes
  144.          ---------     ------------  -----------------------------
  145.             /1         PCBOARD.SYS   PCBoard 12.x (See /P)
  146.             /2         JUMPER.DAT    2 A.M.
  147.             /3                       OPUS 1.12 (not available)
  148.             /4         CHAIN.TXT     WWIV, VBBS, TAG, Telegard
  149.             /5         CURRUSER.BBS  RyBBS
  150.             /6         SFDOORS.DAT   SpitFire
  151.             /7         AUNTIE.SYS    Auntie BBS (Same as /1)
  152.             /8                       Sapphire BBS (not available)
  153.             /9         cmdline       SearchLight,Remote Access, etc.
  154.             /D         DOOR.SYS      DoorWay to Unlimited Doors, GT (See /S)
  155.                                      NOTE : This is the 'Short' DOOR.SYS
  156.             /F         USERINFO.TXT  Forum
  157.             /G         CALLINFO.BBS  Genesis (Beta)
  158.             /H         INFO.TXT      Phoenix
  159.             /M         NUMBER.TXT    ModuleX
  160.             /O         LASTUSER.DAT  Opus 1.14
  161.             /Oxx       LASTUSxx.DAT  Opus 1.14 ('xx' is the task number in hex)
  162.             /P         PCBOARD.SYS   PCBoard 14.x (See /1)
  163.             /S         DOOR.SYS      GAP, Force, Wildcat 3.x,Telegard (See /D)
  164.                                      NOTE : This is the "Long" DOOR.SYS
  165.             /W         CALLINFO.BBS  Wildcat! 2.x, Telegard
  166.             /R         DOORINFO.DEF  Most widely used file
  167.             /R#        DORINFO#.DEF  "#" represents NODE number
  168.                                      EIS-PC, FoReM, OLEcom, QuickBBS, RBBS,
  169.                                      Remote Access, TAG, TPBoard, UBBS, VBBS.
  170.  
  171.     ****If this parameter is missing, UFRD will default to LOCAL mode.****
  172.  
  173.       Drop File Path
  174.  
  175.            If you do not run doors from your BBS's home directory (as
  176.            recommended) you will need to tell REQUEST where to find the
  177.            drop file.  You can either copy the file to the directory that
  178.            holds the REQUEST files, or add the drop file's path to the
  179.            command line.  Here's an example of how to do that running
  180.            PCBoard 14.x, assuming the home directory is C:\PCB.
  181.  
  182.             REQUEST /P:C:\PCB\
  183.  
  184.            NOTE:  The '\' on the end of the path is required.
  185.  
  186.       Other Command Line Parameters:
  187.  
  188.         Local Mode Operation
  189.         --------------------
  190.            /L   Forces LOCAL mode.  Can NOT be overridden.  If
  191.                 either /C or /I are present REQUEST will exit.
  192.  
  193.         FOSSIL Drivers
  194.         --------------
  195.            F-   Do NOT use FOSSIL (/I gives same result)
  196.  
  197.            F+   Force FOSSIL use. (Ignored if /I is present)
  198.  
  199.            F@   Deinitialize FOSSIL when through.  By default, the
  200.                 Request door keeps the FOSSIL "HOT".  This can be
  201.                 combined with the above option (F+@).
  202.  
  203.            /C:n Comport to use (See /C:n below)
  204.  
  205.         Internal Comm Routines
  206.         ----------------------
  207.            /B   Locked Baud rate.  If you are running a Locked comm port
  208.                 you will need this command line switch if you aren't using
  209.                 a FOSSIL.
  210.  
  211.            /C:n Serial Port to use.  You can force the program to use a
  212.                 given serial port.  Valid values are from 1 to 8, but
  213.                 a FOSSIL must be used for serial ports above 4.
  214.  
  215.       /I:x:nnnn Non Standard IRQ specification.  If you are not using a
  216.                 FOSSIL, and you have a non standard serial port configuration
  217.                 you can use this option to specify your IRQ/port address info.
  218.                 The default settings are equivalent to:
  219.                      Com1 : /i:4:03f8
  220.                      Com2 : /i:3:02f8
  221.                      Com3 : /i:4:03e8
  222.                      Com4 : /i:3:02e8
  223.                 The 'x' is the IRQ number.  It is a HEX value from 0 to F.
  224.                 The 'nnnn' us the port address for communications.  If
  225.                 this is present, the FOSSIL routines will not be used.
  226.  
  227.         Other Misc. Cmd Line options
  228.         ----------------------------
  229.            /N   User Name (/N:Paul_Taylor)
  230.                 This option allows you to pass the door the users name
  231.                 through the command line.  This is useful for BBSes like
  232.                 Search Light, or if you are playing locally from DOS.
  233.                 (Underscores are converted to spaces)
  234.  
  235.            /Q   Quite Mode
  236.                 This prevents the Bells from sounding on the local console.
  237.  
  238.            /Z:x User time limit - X is an amount of time between 10 and 50.
  239.                 The users time in the door will be the lesser of this value
  240.                 and the amount shown in the BBS drop file.
  241.  
  242.  The Above command line options work for the REDIT.EXE, REQUEST.EXE and
  243.  RMAIL.EXE programs.
  244.  
  245.  
  246.  
  247.  
  248.  To run any of the above BBS Types Follow this easy layout:
  249.  
  250.          REQUEST <BBS Type:Path To Drop file> <Optional Parameters>
  251.  
  252.       For Example:
  253.  
  254.       On a PCBoard (14.x) with the Home Directory located at C:\PCB\
  255.       the correct command line would be:
  256.  
  257.                       REQUEST /P:C:\PCB\
  258.  
  259.       If you were running a Telegard with a DOOR.SYS drop file, (current dir)
  260.       the correct command line would be:
  261.  
  262.                       REQUEST /S
  263.  
  264.       The following is a copy of the batch file ShadowRift uses to run
  265.       it's copy of the Request door:
  266.  
  267.       F:
  268.       CD\DOOR\REQUEST
  269.       BNU -L0=19200             Loads BNU - Locked port
  270.       REQUEST /P:F:\PCB\NODE1   Loads Request.exe for PCBoard 14.5 (See Note)
  271.       BNU -U                    Unloads BNU
  272.       CD\PCB
  273.       BOARD
  274.  
  275.   Note: In /P:F:\PCB\NODE1 /P: is for PCB 14.x and F:\PCB\NODE1 is the
  276.         path to the PCBOARD.SYS file.
  277.  
  278. Sysop Function Keys
  279.  
  280.    The Sysop has the following Function keys during the programs execution.
  281.  
  282.           Key     Action
  283.          -----    ------------------------------------------------
  284.           F2      Toggle User Status Line.  This will toggle between
  285.                   the following Modes:
  286.                       Display Time Remaining (Default)
  287.                       Display Active Communications
  288.                       Display Remote Graphics
  289.           F7      Reduce users time remaining by 1 minute.
  290.           F8      Increase users time remaining by 1 minute.
  291.           F9      Drop carrier.  This disconnects the current user
  292.                   and simulates line noise.
  293.           F10     Forces the return to the BBS.  This gives the user
  294.                   a message informing them that the Sysop has terminated
  295.                   the session.  It then returns control to the BBS.
  296.  
  297. Sysop Utilities
  298.  
  299.     RMAIL.EXE
  300.     ---------
  301.  
  302.    RMAIL is included in the unregistered version.  This program is designed
  303. to be set up as an Autologin door (for PCBoard).  It functions as a mailbox,
  304. basically.  When a user Requests a file, his name is kept in the record. When
  305. that request finally gets fulfilled, the user who requested it gets a
  306. message written to him in the file MESSAGES.DAT.  RMAIL, upon login, checks
  307. the current users name against this file.  If the user's request has been
  308. fulfilled, RMAIL will show them a message letting them know it has been
  309. fulfilled, the filename it has been upload under and who uploaded it.  If
  310. they don't have any 'mail' it will drop them back to the bbs.
  311.  
  312. NOTE: To test your copy of RMAIL thoroughly, you should have a user call
  313.       and enter a request for any file.  Then, fulfill that request.
  314.       The user should then call back and login as usual.  If you have
  315.       RMAIL set up properly, it should display a message to that user
  316.       that their request has been fulfilled.
  317.  
  318.    RMAIL should work fine for any BBS system that has the ability to run
  319. autologin doors.  (Maybe even running it as a regular door through a
  320. login.bat file.  Not sure if that would work for every BBS, though).
  321.  
  322.  
  323.     REDIT.EXE
  324.     ---------
  325.  
  326.    Included with the Registered version is the program REDIT.  REDIT allows
  327. you to edit/delete Requests and Tag Messages, and UnFulfill requests.
  328. REDIT can be set up as a door as well, allowing a co sysop or some other
  329. "responsible" person to maintain your Request door.  The one thing you
  330. will have to be careful of is if you run a multi-node BBS, you MUST not
  331. run REDIT and have another user in the Request door at the same time.
  332. There could be no problems, but I wouldn't chance it!...
  333.  
  334.     RDAT2TXT.EXE
  335.     ------------
  336.  
  337.    Also included in the Registered version is a utility to convert
  338. the data files for the Request door into a text file.  Possible uses
  339. for this are running a batch file (in nightly maintenance), then copying
  340. the resultant text file REQUEST.TXT file to a pre-determined area:
  341.  
  342.                CD\DOOR\REQUEST
  343.                RDAT2TXT
  344.                COPY REQUEST.TXT \DLS\FILELIST
  345.  
  346.    This way, you can have it set up to automatically update a downloadable
  347. text file each night, or a bulletin.
  348.  
  349.  
  350. Known bugs and anomolies
  351.  
  352.    Currently, there are very few (known, that is. Heh).  The only problems
  353. encountered have been with those using QEMM, occasionally.  Sometimes it
  354. does not like to load correctly with QEMM.  I have had users report that
  355. by removing the first colon from the command line, it seems to work
  356. correctly. Example:
  357.  
  358.                   Regular use:  REQUEST /P:F:\PCB\
  359.                     Modified :  REQUEST /PF:\PCB\
  360.  
  361.    If you find any problems with this software, it would be very much
  362. appreciated if you could report these.  You can report them directly to
  363. the author on ShadowRift BBS (Number at end of docs).  Just send private
  364. mail to Paul Taylor.
  365.  
  366. Credits
  367.  
  368.    The REQUEST program and associated programs were written in Turbo
  369. Pascal 6.0 using Andy Mead's BOI 2.00 door writing routines. These
  370. programs have been alpha and beta tested at ShadowRift BBS and Fear
  371. & Loathing BBS.  All requests for support and registration should be
  372. directed to:
  373.  
  374.                              Paul Taylor
  375.                            P.O. BOX 26190
  376.                       Jacksonville, FL. 32226-6190
  377.  
  378.   Electronic mail can be left on:
  379.  
  380.                 ShadowRift BBS   (HST) 904-696-9238
  381.              Fido net  (1:112/63)    (V32) 904-696-9322
  382.  
  383.  
  384. Closing Kudos
  385.  
  386. The original ideas for these programs were dreamed up by The Doctor and
  387. Empedocles, of Fear & Loathing BBS.  They had been looking for a good
  388. File Request door for quite some time, and put together all the features
  389. they have looked for in a File Request door.  This Door is the result.
  390. Thanks a lot guys!
  391.  
  392. Andrew Mead, for his great communications and door routines.
  393. (BBS Onliner Interface) He helped me out a lot while I was learning
  394. to use his routines.  I didn't know someone could have that many patience!
  395. Without his help, I would never have been able to write these programs.
  396.